15. 课程经理小贴士:查询函数文档

碰到一个陌生的函数时应该怎么做

不论是在优达的课程、作业和项目中,还是我们日常学习中,我们都会接触许许多多的函数。在课程中,我们会讲解较为关键的一部分,但更多的函数还是需要你自己去探究(因为他们实在是太多啦,光Numpy这一个库就至少有2300多个!!!)。因此,在这最开始的一节,我们希望能跟你讨论一下 碰到一个陌生的函数时应该怎么做

首先我们需要明确的一个问题,就是我们 不可能了解全部函数 (依旧是那个原因,他们太多了,不论是数量还是用法), 任何一个想要将全部函数都学会的行为都是及其愚蠢且浪费时间的 。那么,当我们碰到一个陌生的函数,或者某个你已经熟悉的函数的一种比较陌生的用法时,我们应怎么办呢?感谢软件工程这一学科的规范化,任何一个成熟的函数库都会把他们 所有函数的信息(包括定义、功能、输入、输出等) 写进一份document(文档,一般是一个网站)中。因此,当我们碰到一个陌生函数时,我们需要做的就是去 查询

例子

下面,我们以这一段代码来举个例子(这一段代码出自 人工智能编程基础 这一纳米学位中的课程: Lab:我的微信好友 中的一段代码)

plt.pie([sex['male'], sex['female'], sex['unknown']],
        labels=['Male','Female','Unknown'],
        labeldistance = 1.1,
        autopct = '%3.1f%%',
        shadow = False,
        startangle = 90,
        pctdistance = 0.6 
)

定位函数全称、查询

首先我们要做的,就是 定位陌生函数隶属的库与其本身的函数名 ,观察开头,我们可以发现 plt.pie ,考虑到在lab的最开头有

import matplotlib.pyplot as plt

因此,我们可以知道 pie 这一函数是隶属于 matplotlib.pyplot 这一个库的,接下来我们就可以把这个完整的名称( matplotlib.pyplot.pie )丢进百度/谷歌,蹦出来的第一个妥妥就是啦

点进这个 网址

我们接下来会逐步解释这个网页上的内容,以便于你理解它们并将这一方法扩展到其他库函数

内容详解

1. 函数名与全部参数

这一部分表明了 函数的全称 函数的所有参数 ,因此,当你想要使用这一函数时,这一部分是你 必须认真察看 的内容。

在我们的例子中,它对应了我们所定位的函数全称 matplotlib.pyplot.pie ,并且告诉了我们这一函数所需要的所有参数(包括关键字参数对应的默认值)

2. 函数说明

这一部分一般会放在函数名与参数下方,用简明的语言概述这个 函数的功能

在例子中,可以看到,我们查询的这个函数的功能就是根据我们的输入参数绘制一个饼图

3. 参数的详细解释

这一部分十分重要,详细阐述了 每一个参数的功能与格式 ,当我们使用这一函数时,就需要我们配合着函数的全部参数与这一部分详细解释,来具体填写我们需要的函数中的参数

而我们的例子中的代码的各个参数的功能也可以在这一部分一一对应

参数 含义
labels=['Male','Female','Unknown'] 饼图每一个部分的标签
labeldistance = 1.1 标签与饼图中心的距离
autopct = '%3.1f%%' 给出饼图上数字的格式
shadow = False 饼图背景中是否需要阴影,False为不需要
startangle = 90 饼图的起始角度,这里赋值为90,代表了希望将饼图逆时针旋转90度
pctdistance = 0.6 饼图上数字与饼图中心的距离

4. 返回值的解释

在Python中,每一个函数都会有返回值,这一部分就被用来解释这一个函数的返回值的意义与格式

5. 注意事项和例子

这一部分一般会是作者给出的一些例子或者注意事项,可以供我们来参考使用

根据上面的内容,我们再来仔细看看那我们想要查询的函数

plt.pie([sex['male'], sex['female'], sex['unknown']],
        labels=['Male','Female','Unknown'],
        labeldistance = 1.1,
        autopct = '%3.1f%%',
        shadow = False,
        startangle = 90,
        pctdistance = 0.6 
)

根据前面提到的参数与函数功能,这一段函数的意思也就呼之欲出了,也就是根据sex['male'], sex['female'], sex['unknown']这三个数值绘制一个统计学中经常出现的饼图,后面的一系列参数则规定了绘图的各类格式,包括饼图上的标签、表示的数值、背景等。

到这里,我们已经根据这个函数的文档充分了解了目标代码的含义了。我们在这里再总结一下:

当你碰到一个陌生函数时

  1. ** 不要慌!**

  2. 定位这一陌生函数的全称,在搜索引擎中搜索

  3. 找到函数的官方文档,查看每一部分对应的解释

而一个函数的官方文档,一般都会包含以下几部分

  • 函数名与全部参数
  • 函数说明
  • 参数的详细解释
  • 返回值的解释
  • 注意事项和例子

需要注意的是,我们以 matplotlib 这一函数库作为例子进行了匹配与讲解,可惜的是,并不是所有的函数库文档的形式都与 matplotlib 是相同的。但是大多数库函数的文档在编写的时候都会包含这些部分,只是需要你去一一对应,活学活用,这样子,就能无往而不利了~

Enjoy coding and have fun !